org.eclipse.vtp.framework.interactions.core.configurations
Class MediaProviderConfiguration

java.lang.Object
  org.eclipse.vtp.framework.interactions.core.configurations.MediaProviderConfiguration

All Implemented Interfaces:

IConfiguration, InteractionsConstants

public class MediaProviderConfiguration
extends java.lang.Object
implements IConfiguration, InteractionsConstants

A configuration for a media provider.

Author:

Lonnie Pryor

Field Summary

Fields inherited from interface org.eclipse.vtp.framework.interactions.core.configurations.InteractionsConstants

NAME_CHOICE, NAME_CHOICES, NAME_CONTENT_TYPE, NAME_DATA_NAME, NAME_DATA_REQUEST, NAME_FORMATTER, NAME_ID, NAME_INPUT, NAME_INPUT_ITEM, NAME_INPUT_NAME, NAME_INPUT_REQUEST, NAME_INTERACTION_TYPE, NAME_KEY, NAME_LANGUAGE, NAME_LOCALE, NAME_MEDIA, NAME_MEDIA_PROVIDER, NAME_MEDIA_PROVIDER_BINDING, NAME_META_DATA, NAME_META_DATA_ITEM, NAME_META_DATA_SET, NAME_NAME, NAME_OUTPUT, NAME_OUTPUT_ITEM, NAME_OUTPUT_MESSAGE, NAME_OUTPUT_NAME, NAME_PROPERTY, NAME_PROPERTY_ITEM, NAME_RESOURCE_MANAGER, NAME_SCRIPT, NAME_SCRIPTING_LANGUGAGE, NAME_SELECTION_REQUEST, NAME_SHARED_CONTENT, NAME_TRANSFER_MESSAGE, NAME_TYPE, NAME_VALUE, NAMESPACE_URI

Constructor Summary

MediaProviderConfiguration(IContentFactory contentFactory)
Creates a new MediaProviderConfiguration.

Method Summary

void	addSharedContent(SharedContentConfiguration sharedContent) Adds a shared content item to this media provider.
java.lang.String	getFormatterID() Returns the formatter ID name for this media provider.
java.lang.String	getID() Returns the ID of this media provider.
java.lang.String	getResourceManagerID() Returns the ID of the resource manager for this media provider.
SharedContentConfiguration[]	getSharedContent() Returns the shared content in this media provider.
void	load(org.w3c.dom.Element configurationElement) Loads the configuration information from the specified XML element.
void	removeSharedContent(SharedContentConfiguration sharedContent) Removes a shared content item from this media provider.
void	save(org.w3c.dom.Element configurationElement) Saves the configuration information into the supplied XML element.
void	setFormatterID(java.lang.String formatterID) Sets the formatter ID name for this media provider.
void	setID(java.lang.String id) Sets the ID of this media provider.
void	setResourceManagerID(java.lang.String resourceManagerID) Sets the ID of the resource manager for this media provider.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

MediaProviderConfiguration

public MediaProviderConfiguration(IContentFactory contentFactory)

Creates a new MediaProviderConfiguration.

Parameters:

contentFactory - The content factory to use.

Method Detail

getID

public java.lang.String getID()

Returns the ID of this media provider.

Returns:

The ID of this media provider.

setID

public void setID(java.lang.String id)

Sets the ID of this media provider.

Parameters:

id - The ID of this media provider.

getFormatterID

public java.lang.String getFormatterID()

Returns the formatter ID name for this media provider.

Returns:

The formatter ID name for this media provider.

setFormatterID

public void setFormatterID(java.lang.String formatterID)

Sets the formatter ID name for this media provider.

Parameters:

formatterType - The formatter ID name for this media provider.

getResourceManagerID

public java.lang.String getResourceManagerID()

Returns the ID of the resource manager for this media provider.

Returns:

The ID of the resource manager for this media provider.

setResourceManagerID

public void setResourceManagerID(java.lang.String resourceManagerID)

Sets the ID of the resource manager for this media provider.

Parameters:

id - The ID of the resource manager for this media provider.

getSharedContent

public SharedContentConfiguration[] getSharedContent()

Returns the shared content in this media provider.

Returns:

The shared content in this media provider.

addSharedContent

public void addSharedContent(SharedContentConfiguration sharedContent)

Adds a shared content item to this media provider.

Parameters:

sharedContent - The item to add.

removeSharedContent

public void removeSharedContent(SharedContentConfiguration sharedContent)

Removes a shared content item from this media provider.

Parameters:

sharedContent - The item to remove.

load

public void load(org.w3c.dom.Element configurationElement)

Description copied from interface: IConfiguration

Loads the configuration information from the specified XML element.

Specified by:

load in interface IConfiguration

Parameters:

configurationElement - The element to load the configuration from.

save

public void save(org.w3c.dom.Element configurationElement)

Description copied from interface: IConfiguration

Saves the configuration information into the supplied XML element.

Specified by:

save in interface IConfiguration

Parameters:

configurationElement - The element to save the configuration to.